home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sources / xman / xmanhelp < prev   
Text File  |  1994-09-27  |  8KB  |  229 lines
  1.  
  2.  
  3. XMAN is an X Window System manual browsing tool.
  4.  
  5.  
  6.  
  7. GETTING STARTED
  8.  
  9. By default, xman starts by creating a small window that contains
  10. three "buttons" (places on which to click a pointer button).  Two of
  11. these buttons, Help and Quit, are self-explanatory.  The third, Manual
  12. Page, creates a new manual page browser window; you may use this
  13. button to open a new manual page any time xman is running.
  14.  
  15. A new manual page starts up displaying this help information.  The
  16. manual page contains three sections.  In the upper left corner are two
  17. menu buttons.  When the mouse is clicked on either of these buttons a
  18. menu is popped up.  The contents of these menus is described below.
  19. Directly to the right of the menu buttons is an informational display.
  20. This display usually contains the name of the directory or manual page
  21. being displayed.  It is also used to display warning messages and the
  22. current version of xman.  The last and largest section is the
  23. information display.  This section of the application contains either
  24. a list of manual pages to choose from or the text of a manual page.
  25.  
  26. To use xman pull down the Sections menu to select a manual section.
  27. When the section is displayed, click the left pointer button on the
  28. name of the manual page that you would like to see.  Xman will
  29. replace the directory listing with the manual page you selected.
  30.  
  31. That should be enough to get you started.  Once you understand the
  32. basics of how to use xman, take a look at the rest of this file to see the
  33. advanced features that are available to make using xman fast and 
  34. efficient.
  35.  
  36.  
  37. SCROLLING TEXT
  38.  
  39. The scroll bars are similar to xterm and xmh scroll bars; clicking the
  40. left or right pointer button with the pointer at the bottom of the
  41. scroll bar will scroll the text down or up one page, respectively.
  42. Clicking with the pointer farther up the scroll bar scrolls
  43. proportionally less than one page.  Clicking the middle button a
  44. portion of the way down the scroll bar will move the text window that
  45. portion of the way down the text.  Holding the middle button and
  46. moving the pointer up and down allows the text to be scrolled
  47. dynamically.
  48.  
  49. You may also type 'f' or <space bar> to scroll down one page, and
  50. 'b' to scroll up one page.
  51.  
  52.  
  53. RESIZING WINDOWS
  54.  
  55. You can resize any of the windows in xman with your window manager, 
  56. and xman will do the best it can to resize everything internally into
  57. a useful configuration.  The only control over the internal arrangement
  58. that you have is moving the border between the manual page and directory
  59. when both are displayed.  This is done by clicking and holding the any 
  60. pointer button when the cursor is over the small square (grip) on the 
  61. right side of the screen.  The grip is located on the horizontal line 
  62. which separates the panes.  The grip may be moved up and down to resize 
  63. the panes of the screen, and when the pointer button is released xman 
  64. will move the pane boundary to the newly specified location.
  65.  
  66.  
  67. MENU COMMANDS
  68.  
  69. There are two ways to activate the menus.  The first is to click any
  70. pointer button in the menu button corresponding to the menu you want
  71. to activate.  The second method is to hold down the "Control" key and 
  72. click the left pointer button for the Options menu or the middle
  73. pointer button for the Sections menu.  Reguardless of how the menu
  74. was activated, selecting items is the same.
  75.  
  76. Once a menu is activated, continue to hold down the pointer button and
  77. drag the pointer cursor over the item that you would like to activate.
  78. Once the item that you want to select is highlighted, select it by 
  79. releasing the pointer button.  To avoid making a menu selection, move
  80. the pointer cursor outside the menu and release the button.
  81.  
  82. Selecting one of the items in the Sections menu will display the
  83. named directory.
  84.  
  85. The following commands are available through the Options menu:
  86.  
  87. Display Directory        Show the current section directory.
  88.  
  89. Display Manual Page    Show the current manual page.
  90.  
  91. Help                Create a help window with this text displayed.
  92.  
  93. Search            Pop up a dialogue box that allows the entire tree
  94.                 of manual pages to be searched for a specific name.
  95.                 A keyword (apropos) search is also available through
  96.                 this dialogue box.
  97.  
  98. Show Both Screens        Split the manual page display window to display
  99.                 both the current manual page and the directory. 
  100. Show One Screen        Return to a single screen display of either a 
  101.             manual page or directory listing.
  102.  
  103. Remove This Man Page    Remove this manual page, do not quit.
  104.  
  105. Open New Man Page    Pop up a new manual page browser window.
  106.  
  107. Show Version        Print the current version of xman to the information
  108.                 display window.  Please include the version number
  109.                 when reporting bugs.
  110.  
  111. Quit                Close all xman windows and quit xman.
  112.  
  113.  
  114. SUMMARY OF BASIC ACTIONS
  115.  
  116. In a menu button:
  117.  
  118.     CLICK:        Pop up a menu
  119.  
  120. In a directory, manual page, or scroll bar:
  121.  
  122.     <CONTROL> CLICK LEFT:            Pop up the Options menu.
  123.     <CONTROL> CLICK MIDDLE:    Pop up the Sections menu.
  124.  
  125. In a  directory:
  126.  
  127.     CLICK LEFT:                Bring up named manual page
  128.     <SHIFT> CLICK MIDDLE:        Go to manual page previously chosen.
  129.  
  130. In a manual page or apropos listing:
  131.  
  132.     <SHIFT> CLICK MIDDLE:        Go to directory of manual pages.
  133.  
  134. In scroll bars:
  135.  
  136.     CLICK LEFT:        Move down - more if pointer is near bottom
  137.                             of window, less if at top.
  138.     CLICK MIDDLE:        Move top of page to current pointer position.
  139.     CLICK RIGHT:        Move up - more if pointer is near bottom
  140.                       of window, less if at top.
  141.  
  142. SEARCHING
  143.  
  144. Xman has a built-in searching utility that allows the user to search
  145. the entire manual page tree for a specific topic (manual page search)
  146. or a keyword (apropos search).  The search dialogue box can be activated
  147. from the Options menu, or by the key Control-s.  If the search is started
  148. from the small initial topbox xman will open a new manual page if the 
  149. search was successful, and fail silently if the search was unsuccessful.
  150.  
  151. Manual page searches are performed starting in the currently
  152. displayed section.  If no match is found then the remaining sections
  153. are searched in the order that the sections appear in the Sections
  154. menu, starting at the top.  The current version of xman immediately
  155. displays the first manual page that it finds.  If the manual page cannot 
  156. be found that fact is noted in the informational display.
  157.  
  158. An apropos search will search a list of short descriptions for all
  159. manual pages on the system and return a list of all descriptions
  160. which contain the keyword specified.
  161.  
  162.  
  163. KEYBOARD ACCELERATORS
  164.  
  165. Xman contains a set of preinstalled keyboard accelerators.  These are
  166. a set of key bindings that perform many of the same operations as the menu 
  167. items.  Since it is not necessary to pull down the menu,  these actions can 
  168. be performed more quickly, hence the name accelerators.  
  169.  
  170. The default key bindings for xman are:
  171.  
  172. Anywhere:
  173.  
  174.     Control - c        Exit xman
  175.     Control - h        Create the help window
  176.     Control - n        Create a new man page
  177.     Control - q        Exit xman
  178.     Control - s             Create a search popup 
  179.  
  180. In a manual page, directory, or help window:
  181.  
  182.     Control - r        Remove this manual page or help display
  183.     Control - v        Show the current version of xman
  184.  
  185. In a manual page or directory:
  186.  
  187.     Control - d        Display Directory
  188.     Control - m        Display Man Page
  189.  
  190. In a manual page only:
  191.  
  192.     b            Page Back
  193.     f            Page forward
  194.     <Space>            Page forward
  195.     1            One line forward
  196.     2             Two lines forward
  197.     3             Three lines forward
  198.     4             Four lines forward
  199.  
  200. Note: Control-s does not have any effect in the help window.
  201.  
  202.  
  203. FURTHER INFORMATION
  204.  
  205. Xman is highly customizable.  Through the X resource database a user
  206. can customize the look and feel of this application so that it meets a
  207. preferred style of interaction.  Almost any configuration that is available 
  208. dynamically can be specified through resources.  This includes changing the
  209. size, color, and fonts,    starting with no topbox, showing both screens,
  210. and rebinding the keyboard accelerators.
  211.  
  212. The information on customizing xman is contained in the xman manual page,
  213. I will leave it to you to figure out how to find and display that
  214. information :-)
  215.  
  216.  
  217.                     Chris D. Peterson
  218.                     MIT X Consortium
  219.  
  220. CREDITS
  221.  
  222. Version:    Use 'Show Version' menu item.
  223. Written By: Chris D. Peterson - formerly MIT X Consortium
  224. Based Upon: Xman for X10 by Barry Shein - Boston University
  225. Copyright:  1988, 1989 Massachusetts Institute of Technology
  226. Edited by Donna Converse and Dave Sternlicht
  227.  
  228.  
  229.